// IFreeZzaphPlugin.cs
// 
// Copyright © 2009 FreeZzaph
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//

using System;
using System.Collections;
using System.Collections.Generic;

namespace LibFreeZzaph
{
	
	/// <summary>
	/// The "root" plug-in interface. All specific plug-in types will inherit
	/// this interface.
	/// </summary>
	public interface IFreeZzaphPlugin
	{
		/// <value>
		/// The name of the plug-in. Should be all lower case, contain
		/// no whitespace and just be a short identificator, like "sexsite" or
		/// "duplicateremover".
		/// This identificator has to be unique, so make sure to pick something
		/// that cannot be mistaken with something else. One should especially
		/// avoid abbreviations like "ss" (for "sexsite") or "dr" for
		/// "duplicateremover". A good choice is the lowercase full name of the
		/// website this plug-in is representing, with any whitespace and
		/// special symbols removed.
		/// </value>
		string Name { get; }
	}
}
